Platform Explorer / Nuxeo Platform 2023.10

Operation PDF.AddPageNumbers (PDF: Add Page Numbers)

In component org.nuxeo.ecm.platform.pdf.operations

Description

Add the page numbers to the PDF, using the misc parameters. If the PDF is encrypted, a password is required.
Operation id PDF.AddPageNumbers
Category Conversion
Label PDF: Add Page Numbers
Requires
Since

Parameters

Name Description Type Required Default value
fontName string no Helvetica 
fontSize long no 16 
hex255Color string no 0xffffff 
password string no  
position string no Bottom right, Bottom center, Bottom left, Top right, Top center, Top left 
startAtNumber long no 1 
startAtPage long no 1 

Signature

Inputs blob, bloblist
Outputs blob, bloblist

Implementation Information

Implementation Class Class: org.nuxeo.ecm.platform.pdf.operations.PDFAddPageNumbersOperation
Contributing Component org.nuxeo.ecm.platform.pdf.operations

JSON Definition

{
  "id" : "PDF.AddPageNumbers",
  "label" : "PDF: Add Page Numbers",
  "category" : "Conversion",
  "requires" : null,
  "description" : "Add the page numbers to the PDF, using the misc parameters. If the PDF is encrypted, a password is required.",
  "url" : "PDF.AddPageNumbers",
  "signature" : [ "blob", "blob", "bloblist", "bloblist" ],
  "params" : [ {
    "name" : "fontName",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "Helvetica" ]
  }, {
    "name" : "fontSize",
    "description" : null,
    "type" : "long",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "16" ]
  }, {
    "name" : "hex255Color",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "0xffffff" ]
  }, {
    "name" : "password",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "position",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : "Option",
    "order" : 0,
    "values" : [ "Bottom right", "Bottom center", "Bottom left", "Top right", "Top center", "Top left" ]
  }, {
    "name" : "startAtNumber",
    "description" : null,
    "type" : "long",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "1" ]
  }, {
    "name" : "startAtPage",
    "description" : null,
    "type" : "long",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "1" ]
  } ]
}